/*
 * Copyright (c) 2011 MoSync AB
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef MAINTERPETER_EASYBINARYDOWNLOADER_H
#define MAINTERPETER_EASYBINARYDOWNLOADER_H

#include "EasyHttpConnection.h"

namespace MAInterpreter
{

/**
 * I am an easy-to-use downloader for binary data. Inherit me and
 * override onBinaryDownloaded.
 *
 * Call maDestroyObject to deallocate the downloaded data.
 *
 * An instance of me will delete itself on dataDownloaded!
 * Use new to create instances of my subclasses. Do not use automatic
 * allocation.
 *
 * Example of use:
 *
 * class MyBinaryDownloader : public EasyBinaryDownloader
 * {
 *     void onDownloadComplete(MAHandle data)
 *     {
 *         // Do something with the data.
 *     }
 * };
 *
 * // Start download.
 * new MyBinaryDownloader().get("http://...");
 */
class EasyBinaryDownloader : public EasyHttpConnection
{
public:
	// Public protocol.

	/**
	 * Constructor.
	 */
	EasyBinaryDownloader();

	/**
	 * Destructor.
	 */
	virtual ~EasyBinaryDownloader();

	/**
	 * Override to do something with the data that is downloaded.
	 * If download fails, data is NULL.
	 * Note that data must be deallocated using maDestroyObject().
	 */
	virtual void onDownloadComplete(MAHandle data) = 0;

protected:
	/**
	 * Inherited from EasyHttpConnection.
	 * Called when the HTTP connection has finished
	 * downloading data.
	 * Calls onDownloadComplete.
	 * @param data Handle to the data, will be
	 * 0 on error, > 0 on success.
	 * @param result Result code, RES_OK on success,
	 * otherwise an HTTP error code.
	 */
	virtual void dataDownloaded(MAHandle data, int result);
};

}

#endif
